.TH hypersrc 1
.SH NAME
hypersrc - GTK/GNOME source code browser
.SH SYNOPSIS
.B Hypersrc.pl [options] [files] [dirs]
.PP
The front-end Perl script \fBHypersrc.pl\fP should be used
instead of the underlying \fBhypersrc\fP executable.
.SH DESCRIPTION
\fBhypersrc\fP is a GTK/GNOME program that provides a GUI for browsing source code.
\fBhypersrc\fP parses source code files to display a list view of tags
and a tree view of functions which can be clicked to hyperjump through source code.
.PP
.SH OPTIONS
.PP
If no options are passed, then \fBHypersrc.pl\fP will               
default to browsing C src files starting from the CWD
and descending down no more than 5 subdir levels.
If a directory(s) is passed, \fBHypersrc.pl\fP will search the directory(s)
for source files in the specified programming language(s) (default is C).
.PP
(*) If a comma-separated arg contains any spaces it must be quoted.
.TP
.B -force
Keep going if an arg isn't recognized.
.TP
.B -descend (or -d) <n>
How many subdirs to descend while searching for src files.
Pass 1 to descend down to one subdir level.                   
Pass 0 to not descend at all.                                 
(If -d is not passed, default is 5 subdirs.)
.TP
.B -case -no-case (or -nc)
Whether to regard or ignore filename case, resp.            
Default is -case (regard filename case).
(On FreeBSD, -no-case only works if findutils pkg is installed.)
.TP
.B -lang (or -l)  c,c++,java,forth,perl,asm,m4
Affects which kinds of src files this script will search for. 
Multiple languages can be passed (* separate with commas).    
Filenames of other languages can still be passed explicitly.
.TP
.B -langmap
See Exubertant ctags --langmap.
Treats source files with non-standard file extensions
as if they were source files of a supported programming language.
hypersrc doesn't support as many languages as Exuberant does
and will default to C for unsupported ones.  Unlike ctags,
multiple file extensions must be separated by commas.
.TP
.B -ext (or -e) <.fileExtension>
If -lang/-langmap do not support a particular file extension,
then use -ext to specify it.  Eg: '-ext .txt'
Multiple extensions can be passed (* separate with commas).
.TP
.B -include (or -i) <string>
Include any files whose pathnames contain <string>.
Multiple strings can be passed (* separate with commas).
To include all files, pass \\* (escape star).
.TP
.B -exclude (or -x) <string>
Exclude files whose pathnames contain <string>.
Multiple strings can be passed (* separate with commas).
.TP
.B -cd <dir>
Change CWD used by this script.
Can be used to browse a subdir without showing long pathnames.
Should be passed prior to srcs/dirs.
.TP
.B -status
Print messages while starting.
.TP
.B -v
Verbose mode.
.TP
.B -q
Quiet mode.
.TP
.B -geom <x y w h>
Geometry of main window.
.TP
.B -sort-tags=[name,module,type]
Which field to sort tags by.
.TP
.B -column-widths <n1 n2 n3 n4>
Column widths.
.TP
.B -no-line-column
Hide the column containing line numbers of tags.
.TP
.B -font-list <fontname>
Set font of the list widgets.
.TP
.B -font-text <fontname>
Set font of the text widgets.
.TP
.B -title
Set window title.
.TP
.B -no-hilite
Disable highlighting source code.
.TP
.B -no-functree
Skip building function trees (faster startup).
.TP
.B -TagModuleTypeLine -TagTypeModuleLine -ModuleTagTypeLine -ModuleTypeTagLine
Set layout of columns.
.SH EXAMPLES
Examples that descend down to a few subdirs:
.TP
.B Hypersrc.pl
Defaults to C src files: .c/.h
.TP
.B Hypersrc.pl  -lang c,c++
Browse C and C++ src files.
.TP
.B Hypersrc.pl  -lang c c++
WRONG.  Must be one comma-separated word.
.TP
.B Hypersrc.pl -lang perl
Browse only Perl src files.
.TP
.B Hypersrc.pl -langmap=c:+.d *.d
Treat .d files as if they were C source files.
.TP
.B Hypersrc.pl -langmap=c:.d,.e
Treat .d/.e files as if they were C source files.
.TP
.B Hypersrc.pl -ext .cc
Browse only C++ src files ending with .cc
.TP
.B Hypersrc.pl myprog/src
Browse C src files in a subdir.
.TP
.B Hypersrc.pl -x obj/,bak/
Exclude files in these subdirs.
.PP                                                                      
Examples which don't descend into subdirs:
.TP
.B Hypersrc.pl *.f77
Browse Fortran src files.
.SH DEPENDENCIES
\fBhypersrc\fP specifically depends on Exuberant ctags which
can be downloaded from http://ctags.sourceforge.net
.SH SEE ALSO
The latest version is available at:
.PP
http://www.jimbrooks.org/hypersrc/
.PP
http://freshmeat.net/projects/hypersrc/
.SH AUTHOR
Jim Brooks
.SH LICENSE
GNU General Public License (GPL)
